au PAY（ネット支払い）ウェブ方式 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranAupay 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
JobCd	jobCd	必須半角英字7桁処理区分 AUTH：仮売上 CAPTURE：即時売上
Amount	amount	必須半角数字7桁利用金額
Tax	tax	半角数字7桁税送料

URL

/payment/EntryTranAupay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "jobCd": "AUTH",
  "amount": "1000"
}

URL

/payment/EntryTranAupay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&JobCd=AUTH&Amount=1000

レスポンス

正常

AccessID		accessID		必須半角英数32桁固定取引ID
AccessPass		accessPass		必須半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranAupay 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
SiteID	siteID	半角英数13桁サイトID
SitePass	sitePass	半角英数10桁サイトパスワード
MemberID	memberID	半角英数60桁会員ID
MemberName	memberName	半角英数255桁会員名
CreateMember	createMember	半角数字1桁会員作成フラグ会員が存在しない場合の動作を指定します。・0：登録しない　　会員が存在しない場合、エラーを返す。・1：登録する　　会員が存在しない場合、新規登録する。会員ID指定時は必須です。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
Commodity	commodity	全半角48バイト摘要お客様が購入する商品の情報を設定します。設定可能な文字は「全角文字」です。
RetURL	retURL	必須半角英数記号256桁決済結果戻しURL 加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。指定されたURLにブラウザのリダイレクト経由で決済結果が送信されます。
PaymentTermSec	paymentTermSec	半角数字5桁支払開始期限秒お客様が【決済実行】から【支払手続き開始】を呼び出すまでの期限です。最大86,400秒（1日）呼び出しパラメータが空の場合、120秒で処理されます。
ServiceName	serviceName	全角文字48バイト表示サービス名加盟店様のサービス名称です。設定可能な文字は「全角文字」です。
ServiceTel	serviceTel	半角数字記号15桁表示電話番号加盟店様の電話番号です。設定可能な文字は「半角数字と"-"(ハイフン)」です。

URL

/payment/ExecTranAupay.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "retURL": "https://example.com/receive"
}

URL

/payment/ExecTranAupay.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive

レスポンス

正常

AccessID	accessID	必須半角英数32桁固定取引ID
Token	token	必須半角英数256桁固定トークンアクセスIDのハッシュ値を返却します。
StartURL	startURL	必須半角英数記号256桁支払手続き開始IFのURL 支払手続き開始IFのURLを返却します。
StartLimitDate	startLimitDate	必須半角数字14桁固定支払開始期限日時支払手続き開始IFの呼び出し期限を返却します。 yyyyMMddHHmmss書式

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL",
  "startURL": "https://x01.mul-pay.jp/payment/AupayStart.idPass",
  "startLimitDate": "20190225162711"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&Token=qlxcMlmNXu+YJoAPr0zIiHoG/KrcaJJkTVUEeuYe67E3Vh427rKZBJphG0D2YhAL&StartURL=https://x01.mul-pay.jp/payment/AupayStart.idPass&StartLimitDate=20190225162711

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AupayStart 支払手続き開始

お客様をau PAY画面へ遷移させる必要があります。
当サービスのリダイレクト機能を利用して、お客様を当サービスの支払手続き開始IFに誘導してください。
※取引が特定できない場合、すでに支払いを済ませている場合等は、エラー画面を表示します。

リクエスト

AccessID		accessID		必須半角英数32桁固定取引ID 【取引登録】で発行された値を設定します。
Token		token		必須半角英数256桁固定トークン【決済実行】で発行された値を設定します。

URL

/payment/AupayStart.idPass

リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="AupayRedirectCall" action="{接続先URL}" method="POST">
      <noscript>
        <br>
        <br>
        <center>
          <h2>Aupayの決済画面へ遷移します。 </h2>
          <input type="submit" value="続行">
        </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
<!--
function OnLoadEvent() {
document.AupayRedirectCall.submit();
}
//-->
</script>
  </body>
</html>

リダイレクト後、お客様はau PAY画面へ遷移し、決済処理完了後に【決済実行】で指定された決済結果戻しURLへ自動で遷移します。

決済結果受信

au PAYでの決済処理が完了した際に、決済実行時に指定された決済結果戻しURLに結果を通知します。
この決済結果はブラウザ経由で連携されるため、ユーザの操作方法によっては決済完了したにもかかわらず、加盟店様に通知されないことがあります。
その際はショップ管理画面、結果通知、決済状態照会にてご確認ください。また、同様の理由でこの決済結果が複数回加盟店様に通知されることがあります。

レスポンス

正常

ShopID	shopID	必須半角英数13桁固定ショップID
OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態対象取引の取引状態を返却します。・AUTHPROCESS：認証中・AUTH：仮売上・CAPTURE：即時売上・PAYFAIL：決済失敗
TranDate	tranDate	必須半角数字14桁固定処理日時当サービスで処理を実施した日時を返却します。 yyyyMMddHHmmss書式
PayInfoNo	payInfoNo	半角数字16桁決済情報番号オーソリ処理が正常終了した時に振り出される番号です。お客様がau ID画面で確認できます。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

AupaySales 実売上

仮売上の決済に対して実売上を行います。実行時に仮売上時との金額チェックを行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字7桁利用金額
Tax	tax	半角数字7桁税送料

URL

/payment/AupaySales.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "amount": "1000"
}

URL

/payment/AupaySales.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Amount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態対象取引の取引状態を返却します。・SALES：実売上
Amount	amount	必須半角数字7桁利用金額
Tax	tax	必須半角数字7桁税送料

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "SALES",
  "amount": "1000",
  "tax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=SALES&Amount=1000&Tax=0

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

AupayCancelReturn キャンセル・返品

対象の取引をキャンセル・返品します。精算後（売上確定した翌月以降）の取引は一部返品が可能です。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額キャンセル金額 + キャンセル税送料が処理金額となります。キャンセル金額はオーソリ時の金額を指定してください。ただし、対象取引が精算後（売上確定した翌月以降）の場合、[1円～現在の金額]の範囲で指定が可能です。例）請求525円より全額キャンセル→ キャンセル金額：525 請求525円より210円分キャンセル→ キャンセル金額：210
CancelTax	cancelTax	半角数字7桁キャンセル税送料キャンセル金額 + キャンセル税送料が処理金額となります。キャンセル金額はオーソリ時の金額を指定してください。ただし、対象取引が精算後（売上確定した翌月以降）の場合、[1円～現在の金額]の範囲で指定が可能です。例）請求525円より全額キャンセル→ キャンセル金額：525 請求525円より210円分キャンセル→ キャンセル金額：210

URL

/payment/AupayCancelReturn.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "cancelAmount": "1000"
}

URL

/payment/AupayCancelReturn.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&CancelAmount=1000

レスポンス

正常

OrderID	orderID	必須半角英数記号27桁オーダーID
Status	status	必須現状態対象取引の取引状態を返却します。キャンセル・返品成功時は以下のステータスが返却されます。・CANCEL：キャンセル・RETURN：返品
Amount	amount	必須半角数字7桁利用金額利用金額からキャンセル金額を減算した結果を返却します。
Tax	tax	必須半角数字7桁税送料税送料からキャンセル税送料を減算した結果を返却します。
CancelAmount	cancelAmount	必須半角数字7桁キャンセル金額キャンセルした金額を返却します。
CancelTax	cancelTax	必須半角数字7桁キャンセル税送料キャンセルした税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "CANCEL",
  "amount": "0",
  "tax": "0",
  "cancelAmount": "1000",
  "cancelTax": "0"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL&Amount=0&Tax=0&CancelAmount=1000&CancelTax=0

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

DeleteAupayOpenID OpenID解除

サイトID、会員IDを指定すると、該当会員のOpenID解除を行います。
お客様のサービス停止や新しいOpenIDの取得が必要になった場合に、OpenID解除を行ってください。

リクエスト

SiteID	siteID	必須半角英数13桁サイトID
SitePass	sitePass	必須半角英数10桁サイトパスワード
MemberID	memberID	必須半角英数60桁会員ID OpenIDを解除する会員IDを指定します。

URL

/payment/DeleteAupayOpenID.json

リクエストパラメータ

{
  "siteID": "tsite11223344",
  "sitePass": "PASSWORD",
  "memberID": "MEMBER0000001"
}

URL

/payment/DeleteAupayOpenID.idPass

リクエストパラメータ

SiteID=tsite11223344&SitePass=xxxxxxxx&MemberID=MEMBER0000001

レスポンス

正常

SiteID		siteID		必須半角英数13桁サイトID OpenID解除が正常終了の場合は指定されたSiteIDが返却されます。
MemberID		memberID		必須半角英数60桁会員ID OpenID解除が正常終了の場合は指定されたMemberIDが返却されます。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "siteID": "tsite11223344",
  "memberID": "MEMBER0000001"
}

レスポンスパラメータ：正常系

SiteID=tsite11223344&MemberID=MEMBER0000001

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeAupay/SearchTradeMulti 取引状態参照

対象取引の取引状態を取得します。
※SearchTradeMultiはidPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
PayType	payType	半角数字2桁決済方法 SearchTradeMultiをご利用の際は「49」を指定してください。

URL

/payment/SearchTradeAupay.json

リクエストパラメータ

{
	"shopID": "tshop11223344",
	"shopPass": "PASSWORD",
	"orderID": "ORDER0000001"
  }

URL：SearchTradeAupayの場合

/payment/SearchTradeAupay.idPass

URL：SearchTradeMultiの場合

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001

レスポンス

正常

Status	status	必須現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 AUTHPROCESS：認証中 AUTH：仮売上 CAPTURE：即時売上 SALES：実売上 CANCEL：キャンセル RETURN：返品 PAYFAIL：決済失敗
ProcessDate	processDate	必須半角数字14桁固定処理日時処理を実施した日時を返却します。 yyyyMMddHHmmss書式
JobCd	jobCd	必須処理区分 AUTH：仮売上 SALES：実売上 CAPTURE：即時売上 CANCEL：キャンセル RETURN：返品
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
Amount	amount	必須半角数字7桁利用金額
Tax	tax	必須半角数字7桁税送料
SiteID	siteID	半角英数13桁サイトID
MemberID	memberID	半角英数60桁会員ID
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
PayType	payType	必須半角数字2桁決済方法 49：au PAY
AuPayInfoNo	auPayInfoNo	半角数字16桁 au決済情報番号
AupayCancelAmount	aupayCancelAmount	必須半角数字7桁キャンセル金額キャンセル・返品した金額を返却します。
AupayCancelTax	aupayCancelTax	必須半角数字7桁キャンセル税送料金額キャンセル・返品した税送料を返却します。

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
	"status": "CAPTURE",
	"processDate": "20190213200436",
	"jobCd": "CAPTURE",
	"accessID": "a6a6b0061347e90cdef806b39bd28705",
	"accessPass": "5e0e54b892e14ed03e8cf807a6053813",
	"amount": "1000",
	"tax": "0",
	"siteID": "",
	"memberID": "",
	"clientField1": "",
	"clientField2": "",
	"clientField3": "",
	"payType": "49",
	"auPayInfoNo": "",
	"aupayCancelAmount": "0",
	"aupayCancelTax": "0"
  }

レスポンスパラメータ：正常系

Status=CAPTURE&ProcessDate=20190213200436&JobCd=CAPTURE&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&SiteID=&MemberID=&ClientField1=&ClientField2=&ClientField3=&PayType=49&AuPayInfoNo=&AupayCancelAmount=0&AupayCancelTax=0

レスポンスパラメータ：異常系

{
	  "errCode":"E01",
	  "errInfo":"E01040001"
  }

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001